package top.byteio.common.core.annotation.validator;

import jakarta.validation.Constraint;
import jakarta.validation.Payload;

import java.lang.annotation.*;


/**
 * 用于验证状态是否在指定范围内的注解
 * <pre>
 *    通过 {@link FlagValidator#value()} 指定被注解的属性的取值范围，
 *    验证被注解的属性是否在此范围内。如果不在，则通过{@link FlagValidator#message()}
 *    的提示信息，抛出日志
 * </pre>
 * @author lerry
 * @since 2023/7/2 8:53
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD,ElementType.PARAMETER})
@Constraint(validatedBy = FlagValidatorClass.class)
public @interface FlagValidator {

    /**
     * 指定参数值的范围
     */
    String[] value() default {};

    /**
     * 如果参数不在 {@link FlagValidator#value()} 则出现的中提示信息
     */
    String message() default "flag is not found";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}
